<html xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:w="urn:schemas-microsoft-com:office:word"
xmlns="http://www.w3.org/TR/REC-html40">

<head>
<meta http-equiv=Content-Type content="text/html; charset=us-ascii">
<meta name=ProgId content=Word.Document>
<meta name=Generator content="Microsoft Word 9">
<meta name=Originator content="Microsoft Word 9">
<link rel=File-List href="./internationalization_files/filelist.xml">
<!--[if gte mso 9]><xml>
 <o:DocumentProperties>
  <o:Author>mike</o:Author>
  <o:LastAuthor>mike</o:LastAuthor>
  <o:Revision>10</o:Revision>
  <o:TotalTime>12</o:TotalTime>
  <o:Created>2004-11-05T20:35:00Z</o:Created>
  <o:LastSaved>2006-08-17T17:18:00Z</o:LastSaved>
  <o:Pages>2</o:Pages>
  <o:Words>691</o:Words>
  <o:Characters>3939</o:Characters>
  <o:Company>telcordia</o:Company>
  <o:Lines>32</o:Lines>
  <o:Paragraphs>7</o:Paragraphs>
  <o:CharactersWithSpaces>4837</o:CharactersWithSpaces>
  <o:Version>9.6926</o:Version>
 </o:DocumentProperties>
</xml><![endif]--><!--[if gte mso 9]><xml>
 <w:WordDocument>
  <w:Compatibility>
   <w:UseFELayout/>
  </w:Compatibility>
 </w:WordDocument>
</xml><![endif]-->
<style>
<!--
 /* Font Definitions */
@font-face
	{font-family:SimSun;
	panose-1:2 1 6 0 3 1 1 1 1 1;
	mso-font-alt:\5B8B\4F53;
	mso-font-charset:134;
	mso-generic-font-family:auto;
	mso-font-format:other;
	mso-font-pitch:variable;
	mso-font-signature:1 135135232 16 0 262144 0;}
@font-face
	{font-family:"\@SimSun";
	panose-1:2 1 6 0 3 1 1 1 1 1;
	mso-font-charset:134;
	mso-generic-font-family:auto;
	mso-font-pitch:variable;
	mso-font-signature:3 135135232 16 0 262145 0;}
 /* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
	{mso-style-parent:"";
	margin:0in;
	margin-bottom:.0001pt;
	mso-pagination:widow-orphan;
	font-size:12.0pt;
	font-family:"Times New Roman";
	mso-fareast-font-family:"Times New Roman";}
h1
	{mso-style-next:Normal;
	margin-top:12.0pt;
	margin-right:0in;
	margin-bottom:3.0pt;
	margin-left:0in;
	mso-pagination:widow-orphan;
	page-break-after:avoid;
	mso-outline-level:1;
	font-size:16.0pt;
	font-family:Arial;
	mso-font-kerning:16.0pt;}
p.MsoList, li.MsoList, div.MsoList
	{margin-top:0in;
	margin-right:0in;
	margin-bottom:0in;
	margin-left:.25in;
	margin-bottom:.0001pt;
	text-indent:-.25in;
	mso-pagination:widow-orphan;
	font-size:12.0pt;
	font-family:"Times New Roman";
	mso-fareast-font-family:"Times New Roman";}
p.MsoBodyText, li.MsoBodyText, div.MsoBodyText
	{margin-top:0in;
	margin-right:0in;
	margin-bottom:6.0pt;
	margin-left:0in;
	mso-pagination:widow-orphan;
	font-size:12.0pt;
	font-family:"Times New Roman";
	mso-fareast-font-family:"Times New Roman";}
p.MsoListContinue, li.MsoListContinue, div.MsoListContinue
	{margin-top:0in;
	margin-right:0in;
	margin-bottom:6.0pt;
	margin-left:.25in;
	mso-pagination:widow-orphan;
	font-size:12.0pt;
	font-family:"Times New Roman";
	mso-fareast-font-family:"Times New Roman";}
a:link, span.MsoHyperlink
	{color:blue;
	text-decoration:underline;
	text-underline:single;}
a:visited, span.MsoHyperlinkFollowed
	{color:purple;
	text-decoration:underline;
	text-underline:single;}
pre
	{margin:0in;
	margin-bottom:.0001pt;
	mso-pagination:widow-orphan;
	font-size:10.0pt;
	font-family:"Courier New";
	mso-fareast-font-family:"Courier New";}
@page Section1
	{size:8.5in 11.0in;
	margin:1.0in 1.25in 1.0in 1.25in;
	mso-header-margin:.5in;
	mso-footer-margin:.5in;
	mso-paper-source:0;}
div.Section1
	{page:Section1;}
-->
</style>
</head>

<body lang=EN-US link=blue vlink=purple style='tab-interval:.5in'>

<div class=Section1>

<h2><span style='color:black'>Internationalization</span></h2>

<p class=MsoNormal><span style='font-family:Arial;color:black'>BORG supports
Locales (regional settings) as of release 1.3. The Locale can be switched from
the <b><i>Options</i></b> screen. Once a new Locale is chosen, a restart is required
before the new Locale is used. The date formats, month names, and weekday names
are supported for all Locales listed. However, the majority of text strings in
BORG come from a properties file. <o:p></o:p></span></p>

<p class=MsoNormal><span style='font-family:Arial;color:black'><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></span></p>

<p class=MsoNormal><span style='font-family:Arial;color:black'>Except for this
Help and some README files, BORG supports Spanish and German. Translations to
other languages would only require a translated version of the
borg_resource.properties file that comes in the BORG jar file.<o:p></o:p></span></p>

<p class=MsoNormal><span style='font-family:Arial;color:black'><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></span></p>

<p class=MsoNormal><i><span style='font-family:Arial;color:black'>During
development, new strings are added to the program. However, the translations
are not updated by the main developer. Therefore, some new text may appear in
English for the German and Spanish locales until the translations are provided
to the developer.<o:p></o:p></span></i></p>

<p class=MsoNormal><span style='font-family:Arial;color:black'><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></span></p>

<p class=MsoNormal><span style='font-family:Arial;color:black'>Here are
instructions on how to provide a new translation:<o:p></o:p></span></p>

<p class=MsoNormal><span style='font-family:Arial'>============================================<o:p></o:p></span></p>

<p class=MsoBodyText>To change the text strings in BORG, you have to understand
a little about the borg.jar file. A jar (Java archive) file is just a regular
ZIP archive with some extra java related items in it. The borg.jar file can be
unzipped using any tool that works on ZIP files, or using the jar tool that
comes with the Java SDK.</p>

<p class=MsoBodyText>If you unzip the borg.jar file, you will find that it
contains a number of folders &#8211; i.e. net, META-INF, and resource. All of the
files containing the BORG text strings are in the resource folder. By editing
files in the resource folder and then re-zipping the borg.jar file, you can
change the strings shown by the GUI.</p>

<p class=MsoBodyText>There are 3 different categories of text strings shown in
BORG:</p>

<div style='border:none;border-bottom:solid windowtext .75pt;padding:0in 0in 1.0pt 0in'>

<h1 style='border:none;mso-border-bottom-alt:solid windowtext .75pt;padding:
0in;mso-padding-alt:0in 0in 1.0pt 0in'>1.<span style='mso-tab-count:1'>&nbsp;&nbsp;&nbsp;&nbsp; </span>Strings
that come from the Java Runtime</h1>

</div>

<p class=MsoBodyText>These are the Month and Day names. These strings always
appear in the language associated with the locale that is set in the Appearance
tab of the preferences window.<span style="mso-spacerun: yes">&nbsp;
</span>Nothing has to be done to translate these strings.</p>

<p class=MsoBodyText>Just set a new locale, restart BORG, and you should see
translated month and day names.</p>

<p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>

<div style='border:none;border-bottom:solid windowtext .75pt;padding:0in 0in 1.0pt 0in'>

<h1 style='border:none;mso-border-bottom-alt:solid windowtext .75pt;padding:
0in;mso-padding-alt:0in 0in 1.0pt 0in'>2.<span style='mso-tab-count:1'>&nbsp;&nbsp;&nbsp;&nbsp; </span>Strings
that come from Resource Bundles</h1>

</div>

<p class=MsoBodyText>These include all of the GUI labels, table headers, button
text, and menu text except for the month and day names. These come from a
resource bundle called borg_resource. Resource bundles are a standard way that
Java uses to find properties for a given locale.</p>

<p class=MsoBodyText>When you set a locale in BORG, you are setting 2 data
items used by Java - the country and language. Java has a 2 character code for
each of these. </p>

<p class=MsoBodyText>These codes can be found here: <a
href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/locale.doc.html">http://java.sun.com/j2se/1.4.2/docs/guide/intl/locale.doc.html</a></p>

<p class=MsoBodyText>When BORG needs to display a text string, it first looks
for the string in a file called borg_resource_ll_cc.properties, where ll is the
language and cc is the country code.<span style="mso-spacerun: yes">&nbsp;
</span>For example, the file borg_resource_fe_CA is used first if the locale is
set to French/Canada.If the given property is not found in the file, or the
file does not exist, BORG will look for a file of the form
borg_resource_ll.properties. Finally, the default file,
borg_resource.properties is used. This default file is guaranteed to have all
of the required strings. This search algorithm is standard for Java.</p>

<p class=MsoBodyText>The resource files included with BORG are:</p>

<p class=MsoBodyText>borg_resource.properties - for english
borg_resource_es.properties - default for all spanish locales
borg_resource_de.properties - default for all german locales (release 1.3.2)</p>

<p class=MsoBodyText>*** To create a new translation: *** </p>

<p class=MsoList>1.<span style='mso-tab-count:1'>&nbsp;&nbsp; </span>unzip
borg.jar</p>

<p class=MsoList>2.<span style='mso-tab-count:1'>&nbsp;&nbsp; </span>go to the
resource folder. make a copy of borg_resources.properties and name it according
to the locale you will use.</p>

<p class=MsoList>3.<span style='mso-tab-count:1'>&nbsp;&nbsp; </span>For each
string, replace the value on the right side of the equals (=) with the
translated string. Do not touch the value to the left of the equals.</p>

<p class=MsoList>4.<span style='mso-tab-count:1'>&nbsp;&nbsp; </span>re-zip
borg.jar</p>

<p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>

<p class=MsoBodyText>*** To change an existing translation: ***</p>

<p class=MsoList>1.<span style='mso-tab-count:1'>&nbsp;&nbsp; </span>unzip
borg.jar</p>

<p class=MsoList>2.<span style='mso-tab-count:1'>&nbsp;&nbsp; </span>edit the
resource file that you want to change</p>

<p class=MsoList>3.<span style='mso-tab-count:1'>&nbsp;&nbsp; </span>re-zip the
file</p>

<p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>

<p class=MsoListContinue>If you use Java web start, I am not sure where the borg.jar
file is kept, nor if it is ok to edit it. So download the borg ZIP file from
sourceforge if you want to change the text strings.</p>

<h1>3.<span style='mso-tab-count:1'>&nbsp;&nbsp;&nbsp;&nbsp; </span>Strings
that come from regular text or html files inside borg.jar</h1>

<p class=MsoBodyText>These include the Help text, README, License, and CHANGES
text.</p>

<p class=MsoBodyText>These come from regular text or html files in the resource
directory.<span style="mso-spacerun: yes">&nbsp; </span>There is currently no
support in BORG to show different versions of these files based on locale. If
you want to change them, just edit them.<span style="mso-spacerun: yes">&nbsp;
</span>If someone were to send me a translation of these files, I&#8217;d figure out
a way to switch them based on locale.</p>

<div style='border:none;border-bottom:dotted windowtext 3.0pt;padding:0in 0in 1.0pt 0in'>

<p class=MsoNormal style='border:none;mso-border-bottom-alt:dotted windowtext 3.0pt;
padding:0in;mso-padding-alt:0in 0in 1.0pt 0in'><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>

</div>

<p class=MsoBodyText>If you want to send me your translated properties file so
that I can include it</p>

<p class=MsoBodyText>in the next release, email it to me at <a
href="mailto:i_flem@users.sourceforge.net">i_flem@users.sourceforge.net</a><span
style='font-family:Arial'><o:p></o:p></span></p>

</div>

</body>

</html>
